Export PGAS Data XML Commands

Export: PGAS Data XML

Note: This command is provided as an optional feature. For this command to function, an additional file requirement must be met.

Export: PGAS XML (EXPPGAS via script) is a system-level command that triggers the FMS service to export raw data out of CygNet Measurement as an XML file consumable by Quorum PGAS (conforms to version 16). For each eligible Node the command resolves to, the service will gather data as specified in the command parameters, within a specified time range, and export it to a specified directory location as an XML file.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Requirement

To enable the command to export raw data to PGAS XML files, and see the command listed in command management options, the following elements must be present.

PGAS Export CDF - CygNet Measurement provides a command definition file (CDF) that must be made available on your system to enable the raw data to be exported from FMS to PGAS XML files. The data item mappings necessary to execute the export command to the corresponding PGAS file format are hard-coded in the system, and are not editable at this time. See Utilizing the Command Definition File for more information about data item mappings.

The specific CDF file (ExportPgasXml.cdf) must be included in the CygNet\Services\FMS\CommandDefs folder on your host server, as follows.

On your host server, in the CygNet\Services\FMS\CommandDefs\ExportSamples folder, find the SampleExportPgasXml.cdf (command definition) file and copy it up one level to the CygNet\Services\FMS\CommandDefs folder. Important: Do not alter or add to the sample file contents.
Remove the word "Sample" from the file name (for the new copy of the file). The file must be named ExportPgasXml.cdf so that the file will be recognized by the FMS service.
Restart the FMS service.

Note: Refer to Quorum PGAS documentation and/or contact your PGAS representative for the most current information about PGAS versions, and specific PGAS configuration details.

Command Definition Properties

The following command definition properties apply to Export: PGAS XML commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Time format	Select the desired Time format for the command from the drop-down menu. Options are as follows. Contract Device Default value is Device time. Notes: This parameter determines how the time window is selected in the database; not how the data is exported. For daily devices only, specifying start and end times of midnight (00:00:00), will always be interpreted as Contract time format, regardless of this selected parameter value.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Property

Description

FMS service

Select a Site.Service for the command from the available FMS service list in the drop-down menu.

Command

Select the desired Command name from the drop-down menu.

See FMS Commands for more information about available command types.

Time format

Select the desired Time format for the command from the drop-down menu.

Options are as follows.

Contract
Device

Default value is Device time.

Notes:

This parameter determines how the time window is selected in the database; not how the data is exported.

For daily devices only, specifying start and end times of midnight (00:00:00), will always be interpreted as Contract time format, regardless of this selected parameter value.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

Low level
Medium level
High level
User initiated transaction
Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

Low - displays errors
Medium - displays errors and warnings
High - displays errors, warnings, and status

Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Command Parameters

The following command parameters apply to Export: PGAS XML commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
ExStDate	Start date/time	DateTime	Double-click to access the Select Start Date/time dialog box. Select the starting date/time of the range for which to export data. See Selecting Date and Time for more information. This parameter is required.
ExEndDate	End date/time	DateTime	Double-click to access the Select End Date/time dialog box. Select the ending date/time of the range for which to export data. See Selecting Date and Time for more information. This parameter is required.
ExPath	Directory to export file	File Directory	Double-click to access the Enter Directory to Export File dialog box. Type the directory location for the XML export file destination into the text box or click ... to access the Browse for Folder dialog box, and browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS service. See Notes ** below this table. This parameter is required.
ExDirFmt	Export directory format	String Enum	Double-click to access the Export Directory Format dialog box. Select a file directory format for the XML export file. Options are as follows. Directory for each polling facility (2 via script) Directory for each device (0 via script) Single directory for all devices (3 via script) This parameter is required. Default value is Directory for each polling facility.
ExFileNm	Name of export file	String Enum	Double-click to access the Enter File Name dialog box. Select a file name format for the XML export file. Options are as follows. Date the export file was created (1 via script) Date of first export history value (3 via script) Node name (4 via script) See Notes ******* below this table. This parameter is required. Default value is Date the export file was created.

Parameter

Description

Type

Usage Notes

ExStDate

Start date/time

DateTime

Double-click to access the Select Start Date/time dialog box.

Select the starting date/time of the range for which to export data.

See Selecting Date and Time for more information.

This parameter is required.

ExEndDate

End date/time

DateTime

Double-click to access the Select End Date/time dialog box.

Select the ending date/time of the range for which to export data.

See Selecting Date and Time for more information.

This parameter is required.

ExPath

Directory to export file

File Directory

Double-click to access the Enter Directory to Export File dialog box.

Type the directory location for the XML export file destination into the text box or click ... to access the Browse for Folder dialog box, and browse to the directory location.

Note: The directory specified is relative to the computer hosting the FMS service.

See Notes ** below this table.

This parameter is required.

ExDirFmt

Export directory format

String Enum

Double-click to access the Export Directory Format dialog box.

Select a file directory format for the XML export file.

Options are as follows.

Directory for each polling facility (2 via script)
Directory for each device (0 via script)
Single directory for all devices (3 via script)

This parameter is required. Default value is Directory for each polling facility.

ExFileNm

Name of export file

String Enum

Double-click to access the Enter File Name dialog box.

Select a file name format for the XML export file.

Options are as follows.

Date the export file was created (1 via script)
Date of first export history value (3 via script)
Node name (4 via script)

See Notes *** below this table.

This parameter is required. Default value is Date the export file was created.

Notes:

** Directory to export file - Make sure that you are cognizant of the system in which you are specifying the file location. The file location selected when you Browse For Folder will be relative to your local computer file system, whereas the file location generated when the command is executed will be relative to the computer hosting your FMS Service, which could be a separate system.

*** Name of export file - If using Node name format and the file name already exists (as a valid PGAS XML file) in the specified destination, the export will fail. If using date-based name formats and the file name already exists, any new data exported by this command will be appended into the existing file and a two-digit index number added to the file name, up to a maximum index of 99, after which point the export will no longer succeed.